Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: fix misspelled words #2852

Closed
wants to merge 2 commits into from
Closed

docs: fix misspelled words #2852

wants to merge 2 commits into from

Conversation

Caerlower
Copy link

@Caerlower Caerlower commented Nov 16, 2023 •
edited by coderabbitai bot
Loading

Closes #2848

Summary by CodeRabbit

  • Bug Fixes

    • Corrected typos in comments across various files for improved code clarity and documentation accuracy.
    • Updated calculations in the shareSplitter logic to ensure at least one share is accounted for, enhancing the accuracy of share splitting functionality.

  • Refactor

    • Standardized the capitalization in function names within comments to maintain consistency in code documentation.

  • Documentation

    • Fixed typographical errors in code comments to enhance the understanding of the codebase for developers and maintainers.

@celestia-bot celestia-bot requested a review from a team November 16, 2023 19:22
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 16, 2023 •
edited
Loading

Walkthrough

The changes across various Go files in the celestiaorg/celestia-app repository are minor and primarily focus on correcting typographical errors in comments. These corrections include fixing misspelled words and adjusting a calculation by adding 1 to ensure at least one share is accounted for. There are no changes to the logic or functionality of the code.

Changes

File Path Change Summary
app/split_shares.go Corrected a typo in a comment and updated share calculation by adding 1.
x/payment/types/.../builder.go Fixed a single-word typo in a comment.
x/payment/types/.../events.go Corrected typos in comments and capitalized a function name in a comment.
x/payment/types/.../payfordata.go Fixed a typo in a comment.

Assessment against linked issues (Beta)

Objective Addressed Explanation
#2848: Correct misspelled words in comments ✅ The provided diffs show that all identified misspelled words in comments have been corrected.
#2848: Resolve CI setup issue to prevent new misspellings ❓ There is no information provided in the summary regarding updates to the CI setup to address spellcheck configurations.

As autumn leaves 🍂 gently fall,
A rabbit 🐇 hops through the code, so tall.
With every hop, a typo fixed,
Ensuring words are aptly mixed. 🌟

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • If you reply to a review comment from CodeRabbit, the bot will automatically respond.
  • To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
  • Note: Review comments are made on code diffs or files, not on the PR overview.
  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

coderabbitai[bot]
coderabbitai bot reviewed Nov 16, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 9b5d025 and e6b955a.
Files selected for processing (4)
  • app/split_shares.go (2 hunks)
  • x/payment/types/builder.go (1 hunks)
  • x/payment/types/events.go (1 hunks)
  • x/payment/types/payfordata.go (1 hunks)
Files skipped from review due to trivial changes (4)
  • app/split_shares.go
  • x/payment/types/builder.go
  • x/payment/types/events.go
  • x/payment/types/payfordata.go

staheri14
staheri14 previously approved these changes Nov 16, 2023
View reviewed changes
@rootulp rootulp changed the title Misspelling correction docs: fix misspelled words Nov 16, 2023
@rootulp
Copy link
Collaborator

rootulp commented Nov 16, 2023 •
edited
Loading

Thanks for the contribution @Caerlower ! I updated the PR title to conform to convenitonal commits. See https://github.com/celestiaorg/celestia-app#contributing

This PR has a few merge conflicts so do you mind fixing them?

Also it would be helpful to understand why CI didn't catch these spellings mistakes earlier? Is there anything we can add to existing CI so that misspelled words get caught earlier?

@Caerlower
Copy link
Author

Caerlower commented Nov 16, 2023 •
edited
Loading

Thanks for the contribution @Caerlower ! I updated the PR title to conform to convenitonal commits. See https://github.com/celestiaorg/celestia-app#contributing

This PR has a few merge conflicts so do you mind fixing them?

Also it would be helpful to understand why CI didn't catch these spellings mistakes earlier? Is there anything we can add to existing CI so that misspelled words get caught earlier?

Yes, let me fix the merge conflicts.

I checked the files but I didn't understand where this conflict might be arising from. There was one space which I removed can you please check if it's still getting problem?

@celestia-bot celestia-bot requested a review from a team November 16, 2023 20:52
coderabbitai[bot]
coderabbitai bot reviewed Nov 16, 2023
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between e6b955a and bcf14c6.
Files selected for processing (1)
  • x/payment/types/events.go (1 hunks)
Files skipped from review due to trivial changes (1)
  • x/payment/types/events.go

@rootulp
Copy link
Collaborator

rootulp commented Nov 17, 2023

Yep there are still merge conflicts b/c this:

Screenshot 2023-11-17 at 9 59 16 AM
  1. In the future, you can minimize the likelihood of a merge conflict by pulling the latest upstream branch (main) and then applying your work on top of that.
  2. I can push a commit to resolve merge conflicts if that's okay with you

@rootulp
Copy link
Collaborator

rootulp commented Nov 17, 2023

Ahh the merge conflicts arise b/c they're in files that have been deleted and/or moved. The typos are no longer an issue b/c #2848 (comment)

Thanks for your interest @Caerlower ! We hope you continue contributing via other PRs!

@rootulp rootulp closed this Nov 17, 2023
@Caerlower
Copy link
Author

Ahh the merge conflicts arise b/c they're in files that have been deleted and/or moved. The typos are no longer an issue b/c #2848 (comment)

Thanks for your interest @Caerlower ! We hope you continue contributing via other PRs!

Okay, Thanks for assigning me the request. I will keep the learnings in mind to check before head if the codebase is old or new.

@Caerlower Caerlower deleted the spell-correct branch November 17, 2023 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@evan-forbes evan-forbes evan-forbes approved these changes

@staheri14 staheri14 staheri14 left review comments

@rootulp rootulp Awaiting requested review from rootulp

@cmwaters cmwaters Awaiting requested review from cmwaters

Assignees

@Caerlower Caerlower

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

misspelled words
4 participants
@Caerlower @rootulp @staheri14 @evan-forbes